@DATABASE "Default"
@Ver$ "LinkChecker GUI V2.1 (07/07/98)"
@author "Heiko Schröder"
@Index MAIN
@remark requires MultiView

@NODE "Main" "LinkChecker GUI 2.1"
@TOC "MAIN"
               ******************************************
               * @{fg shine}Link Checker GUI@{fg text} V2.1 (07/07/98)       *
               * © Heiko Schröder (age@thepentagon.com) *
               ******************************************

   This program is mailware. If you use this program to check your HTML pages
   please send me an email to give me a piece of your mind.
   I want to get a feedback of my work ;-)

                           @{" " link "Insp"} Inspirations
                           @{" " link "TLC"} Features

                           @{" " link "Req"} Requirements
                           @{" " link "Ins"} Installation
                           @{" " link "Con"} Configuration
                           @{" " link "Usa"} Usage
                              @{" " link "MWind"} The Main Window
                              @{" " link "RWind"} The Result Window

                           @{" " link "Auto"} Author
                           @{" " link "Hist"} History

                           @{" " link "Fut"} Future

@{fg shine}              Please check out my last project at the Internet:
                         http://www.leipzig-info.net

@ENDNODE

@NODE "Insp" "Inspirations"
@TOC "MAIN"


Some time ago I've created my »HomeBase of Age«
(you can find it at "http://yi.com/home/SchroederHeiko").

Manually I had to check all the links of these (S)HTM(L) pages. A hard work ;-(
I looked for a tool at AMINET to solve this problem. No chances. I found
programs to check the accuracy of the HTML syntax and a program called
"CheckLink" © by Fabio Rotondo. But that's a tool for Shell/Cli.

I've started programming it in ARexx. (YES, in ARexx.)
And now you have the result on YOUR AMIGA. A LinkChecker with a graphical user
interface (GUI).

                                       @{" >>> next >>> " link "TLC"}
@ENDNODE

@NODE "TLC" "The features of LinkChecker-GUI"
@TOC "MAIN"


This ARexx script allows you to check local links at all your (S)HTM(L) pages
and reports broken links, orphaned files and critical problems with Unix file 
conventions.
No shell input. 
Controllable via mouse and keyboard.
Configurable to fill your needs.

It checks local links with this syntax:

   * links like <a href=...>
                <link rel=... href=...>

     e.g.:<a href="example.(s)htm(l)"> <a href=example.(s)htm(l)>
          <link rel="..." href="example.html">

     unix links like
      HREF=../../../age/example.(s)htm(l)>
      HREF=/age/example.(s)htm(l)>

   * links like <img src=...>
                <img dynsrc=...>
                <layer src=...>
                <embed src=...>
                <frames src=...> <iframe src=...> 
                <app src=...>
                <script src=...>

     e.g.: <IMG SRC="example.gif"> <IMG SRC=example.gif>
           <layer src="example.htm">
           <embed src="example.java">
           <script src="example.js">
           <app src="example.txt">

     unix links like
      SRC=../../../age/example.gif
      SRC=/age/example.gif

   * anchor links
      <A HREF="example.(s)htm(l)#anchor")

It doesn't check following:

   * external links:
      Mailto:
      http://
      ftp://
      Telnet://
      gopher://
      news:

   * local links (browser links):
      about:
      x-nil:

                                       @{" >>> next >>> " link "Req"}

@ENDNODE

@NODE "Req" "Requirements"
@TOC "MAIN"


Sys:System/RexxMast        | © 1987 by William S. Hawes

C:Delete                   | © by Commodore / Amiga Technologies
                               & Amiga International
C:Flushtrx                 | © 1995 by Jürgen Kohrmeyer

Libs:regexp.library        | © 1991 by Stephen Moehle
Libs:rexxreqtools.library  | © 1994 by Rafael D'Halleweyn
Libs:tritonrexx.library    | © 1995 by Jürgen Kohrmeyer
Libs:rexxtricks.library    | © 1995 by Jürgen Kohrmeyer

These libraries and FlushTRX are included in this package.

                                       @{" >>> next >>> " link "Ins"}

@ENDNODE

@NODE "Ins" "Installation"
@TOC "MAIN"

   Please install the included libraries into your directory LIBS:
   and c/flushtrx into C:
   You can install the rest of this package to any location do you want.

   That's all ;-)

   As next @{"configure" link "Con"} the program values via tooltype.

                                       @{" >>> next >>> " link "Con"}

@ENDNODE

@NODE "Con" "Configuration"
@TOC "MAIN"

   After @{"installation" link "Ins"} you have to configure the program values.
   Click at »LinkChecker GUI« icon. 
   Select workbench menu to manipulate the tooltype of this icon:
         * german  - Piktogramm | Informationen ...
         * english - Icons | Information ...

   The main value you have to configure is your favorite text editor:
         * select "EDITOR"
         * you have to give the name (with path) of your editor
           (e.g. MEmacs)

   Next step:
         * select "REXXCOMMAND"
         * give the ARexx command of your editor to jump directly to the
           line where the broken link can be found
         - the variable "%line" is the option of LinkChecker to hand over the
           line that includes the broken link to the editor
           (e.g. goto %line OPT W)

   You don't have to fill out the other values. They will be automatically set
   while using LinkChecker.

                                       @{" >>> next >>> " link "Usa"}

@ENDNODE

@NODE "Usa" "Usage"
@TOC "MAIN"

   Double click the »LinkChecker GUI« icon.

   The last versions of LinkChecker has produced fatal errors while analyzing
   an empty main directory. Now you have to select a directory where at least 
   one HTML file is located. Otherwise an error message will be appear.

      @{" The Main Window   " link "MWind"}
      @{" The Result Window " link "RWind"}

@ENDNODE

@NODE "MWind" "Usage - Main Window"
@TOC "MAIN"

@{fg shine}The Main Window@{fg text}
   First you can select either to check a complete directory with all
   subdirectories or only one file.
   Below you can select the directory or file. It will be listed in the
   separated field.

   Then you can select the type of checking.
      * case sensitive filenames for unix systems (e.g. AgE.hTmL)
      * check of anchor links (e.g. age.html#start)
      * list of orphaned files 

   If you don't select anything, the normal check will be executed.

   @{fg fill}Start@{fg text} - starts the check and opens the @{"result window" link "RWind"}.
   @{fg fill}Save@{fg text}  - all infos will be saved into tooltypes
   @{fg fill}Info@{fg text}  - opens a window with info of version and author
                               (like menu: ? | Info)
   @{fg fill}Quit@{fg text}- leaves the program
                               (like menu: Project | Quit)

   The menu: "? | Help" opens this guide.


                                       @{" >>> next >>> " link "RWind"}

@ENDNODE

@NODE "RWind" "Usage - Result Window"
@TOC "MAIN"

@{fg shine}The Result Window@{fg text}
   The script checks the (S)HTM(L) files that have been found in the selected 
   directory. 

   @{fg shine}broken link in:@{fg text}
   In the top left edge of the window you can find all broken links.

   @{fg shine}broken case sensitive link in:@{fg text}
   In the bottom left corner you find links that are broken on Unix systems.

   @{fg shine}broken anchor link in:@{fg text}
   At the top right broken anchor links will be listed.

   @{fg shine}orphaned files:@{fg text}
   And last but not least in the bottom right corner you can find files 
   that are not referenced by actual pages.

   Only those listviews are activated that belong to the selected type
   of checking.

   First, all files will be scaned for anchor links <a name=...>
   After that every file will be checked for all types of links.
   Detected errors will be listed immediately.
   A progress bar tells you the progress of work.

   After checking of files has ended and NO files are listed in any list
   all links work correctly ;-) You are able to upload your new pages to
   the web server.

   If not, you have to work on your files:
   With the button @{fg fill}Info@{fg text} you can get information about the broken link.
        File     : the file, where the broken link is located in
        links to : name of the target file
        at line  : line of the file

        @{fg fill}Edit@{fg text} allows you to manipulate this file with your favorite text
               editor (see @{"configuration" link "Con"}).
        @{fg fill}Cancel@{fg text} will close the info window.

   With the button @{fg fill}I know@{fg text} you can remove the file from the list.
   It will not be deleted from your system!!!

   At @{fg shine}orphaned files:@{fg text} you find the button @{fg fill}Delete@{fg text}.
   Here you can delete the selected file from your system.

   That's all ;-)

-------------------------------------------------------------------------------

   All broken links will also be reported at log files.
      T:LinkCheckResult          - broken links
      T:LinkCheckResult-Unix     - broken case sensitive links
      T:LinkCheckResult-Anchor   - broken anchor links

    e.g.:
      HD1:Homepages/Age/main.html - next.html - line 123

    This informs you, that a link from main.html to next.html at line 123 doesn't
    work.

                                       @{" >>> next >>> " link "Auto"}

@ENDNODE

@NODE "Auto" "Author"
@TOC "MAIN"

             Send improvements, tips or problems to me.

       @{fg shine}                    Heiko Schröder
                           Arnoldstr. 1
                           D-04299 Leipzig
                   E-Mail: age@thepentagon.com
                 HomeBase: http://yi.com/home/SchroederHeiko

            @{fg text}Leipzig, 07. July 1998

                                       @{" >>> next >>> " link "Hist"}

@ENDNODE

@NODE "Hist" "History"
@TOC "MAIN"


Version    Date     Improvements
-----------------------------------------------------------------------------
 V2.1      07/07/98 - saves faster failed links in T:
                    - saves faster the tooltypes
                    - scans faster the links with the regexp.library (5%)
                    - scans faster the orphaned files (66%)
                    - for german users it checks äöüß in filenames for unix
           bugfixes - scans also files in a main directory 
                      (e.g. work:index.html)
                    - name of directory/file will be remaining if you 
                      press ESC in the requester of reqtools
                    - list filenames correct at listview by file option
           extended - START is only usable if you have selected a file or dir
                    - "I know" button at the Info Requester
                    - modular procedures in the script

 V2.0      05/14/98 - official release (no error comments by any user)
                    - checks correct unix links like: href="/images/xyz.gif"
                    - bugfix: renamed tooltype NOTLINKED to NOLINK (double
                              variable names)
                    - there were fatal errors by analyze the main directory
                      it now checks if at least one HTML file is located at the 
                      main dir
                    - a requester tells you if selected directory (file) 
                      doesn't exist
                    - this guide is available
                    - no more menus; all functions are attainable via window 
                      buttons

 V2.0 b3   03/15/98 - final beta
                    - uses features of rexxtricks.library (soft HD grip)
                      (fast comparison routines; no slow system commands ;-)
                    - tooltype support (no separate preferences window)
                    - check of anchor links
                    - only "orphaned files" check, if directory scan is
                      used

 V2.0 b2   02/26/98 - menu added
                    - preferences for your favorite text editor
                    - temporary files will be deleted
                    - empty link will not displayed as broken link

 V2.0 b1   02/23/98 - first release of the GUI version


previous non-gui version of LinkChecker:
----------------------------------------
 V1.4     09/09/97  - code optimized -> higher speed
                    - checks "Telnet://"
                    - file or directory scanning
                    * ExtLinkChecker
                    - beta of link checking via IBrowse
                    - link checking via AWeb works

 V1.3     08/07/97  * ExtLinkChecker
                    - new script to check EXTERNAL links via AWEB
                    - now also more than 1 links at one line will be
                      checked (sorry, but other versions checked
                      only the first link at one line)
                    - second public release

 V1.2     08/01/97  - checks also "...shtm" & "...shtml" files
                      "<FIG SRC=xxx.xxx>" ; "<EMBED SRC=xxx.xxx>"
                    - if link errors have been found, a requester
                      shows the missed files
                      thanks for inspirations to David Ceulemans
                    - code optimized
                    - not released

 V1.1     07/30/97  - now checks also e.g.: "../../../../x.html"
                      thanks for inspirations to Brian Hosty
                    - doesn't check info files (e.g.: x.html.info) ;-)
                    - code optimized
                    - not released

 V1.0     07/24/97  - the first public release on Aminet


                                       @{" >>> next >>> " link "Fut"}
@ENDNODE

@NODE "Fut" "Future"
@TOC "MAIN"

   An HTML optimizer. The existing program WEBMiZ doesn't work correctly.

                                           End of Guide
                                       @{" >>> Contents >>> " link "Main"}
@ENDNODE